Microsoft.ApiManagement : Release api-version 2021-04-01-preview #15832

solankisamir · 2021-08-27T17:27:42Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…021-01-01-preview to version 2021-04-01-preview

* Added support for GraphQL API type * Added missing enum value for GraphQL APIs.

Co-authored-by: Alan Feng <alanfeng@microsoft.com>

* outbound dependency * fix resource

* Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id

* system-data * fix spec * remove unreferenced file

) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

* HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

…perties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix

* Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

…021-01-01-preview to version 2021-04-01-preview

* Added support for GraphQL API type * Added missing enum value for GraphQL APIs.

Co-authored-by: Alan Feng <alanfeng@microsoft.com>

* outbound dependency * fix resource

* Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id

* system-data * fix spec * remove unreferenced file

) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

* HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

…perties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix

* Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

chunyu3 · 2021-09-14T03:02:52Z

/azp run

azure-pipelines · 2021-09-14T03:03:03Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-workflow-bot · 2021-09-14T05:04:57Z

Hi @solankisamir, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

solankisamir · 2021-09-15T05:45:43Z

@VitaliyKurokhtin we would need signoff from Breaking change reviewers for deprecating the samples property from RepresentationContract, which got removed as part of PR - #14836

See run https://github.com/Azure/azure-rest-api-specs/pull/15832/checks?check_run_id=3594297851

According to @chunyu3 that is blocking merging this PR

solankisamir · 2021-09-20T20:13:58Z

@chunyu3 we already got the exception as part of the PR - #15377

Do we need to request a new one?

VitaliyKurokhtin · 2021-09-20T20:31:25Z

Same question to @JeffreyRichter. We've already been through breaking change of replacing "sample" property with examples here #15377. This is the next version of our API should we got through breaking change process again?

JeffreyRichter · 2021-09-20T21:24:41Z

When I look here: https://github.com/Azure/azure-rest-api-specs/pull/15832/checks?check_run_id=3594297851
I see lots of breaking changes. What is the justification for these breaks?

solankisamir · 2021-09-20T22:27:32Z

@JeffreyRichter I can only see 1 breaking change

JeffreyRichter · 2021-09-20T22:38:00Z

Technically, the type changes are also breaking but we tend to allow changes from nothing to object.

But removing a property is breaking.

VitaliyKurokhtin · 2021-09-20T23:17:02Z

Here is timeline:

In 2020-12-01 we have property "sample".
in 2021-01-01-preview it was removed by Spec fixed to reflect new examples property #15377 (breaking change)
In this 2021-04-01-preview automation compares it to previous stable (2020-12-01) and sees same breaking change from second point.

How should we handle multiple consecutive -preview versions where each has same breaking change?

JeffreyRichter · 2021-09-21T00:09:18Z

OK, I approved the PR. I dont' think there is a way to stop getting flagged with breaking changes until this comes out of preview.

chunyu3 · 2021-09-21T04:23:11Z

/azp run

azure-pipelines · 2021-09-21T04:23:21Z

Azure Pipelines successfully started running 1 pipeline(s).

chunyu3 · 2021-09-23T03:16:05Z

Contact with @zhenglaizhang , we can ignore 'swagger ApiDocPreview' failure since apimanagement can re configure operation group in their prod rest doc generation.

…on 2021-04-01-preview (#1929) Create to sync Azure/azure-rest-api-specs#15832 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/apimanagement?expand=1)

…re#15832) * Adds base for updating Microsoft.ApiManagement from version preview/2021-01-01-preview to version 2021-04-01-preview * Updates readme * Updates API version in new specs and examples * Added support for GraphQL API type (Azure#14851) * Added support for GraphQL API type * Added missing enum value for GraphQL APIs. * add schema definition fix from 2021-01-01-preview (Azure#14883) Co-authored-by: Alan Feng <alanfeng@microsoft.com> * Vanguard: Get Outbound Network Dependency (Azure#14900) * outbound dependency * fix resource * Update backup/restore API for managed identities (Azure#14973) * Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id * SystemData implemenation on API Management Control Plane (Azure#14899) * system-data * fix spec * remove unreferenced file * APIM - Network Watcher Connectivity Check integration specs (Azure#15056) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Parameter examples added (Azure#14836) * platformversion (Azure#15114) * fix update service (Azure#15478) * HttpConnect example (Azure#15493) * HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Added properties of difference API spec format for "SchemaDocumentProperties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix * [APIM]Add private endpoint connection APIs (Azure#15115) * Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * Adds base for updating Microsoft.ApiManagement from version preview/2021-01-01-preview to version 2021-04-01-preview * Updates readme * Updates API version in new specs and examples * Added support for GraphQL API type (Azure#14851) * Added support for GraphQL API type * Added missing enum value for GraphQL APIs. * add schema definition fix from 2021-01-01-preview (Azure#14883) Co-authored-by: Alan Feng <alanfeng@microsoft.com> * Vanguard: Get Outbound Network Dependency (Azure#14900) * outbound dependency * fix resource * Update backup/restore API for managed identities (Azure#14973) * Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id * SystemData implemenation on API Management Control Plane (Azure#14899) * system-data * fix spec * remove unreferenced file * APIM - Network Watcher Connectivity Check integration specs (Azure#15056) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Parameter examples added (Azure#14836) * platformversion (Azure#15114) * fix update service (Azure#15478) * HttpConnect example (Azure#15493) * HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> * Added properties of difference API spec format for "SchemaDocumentProperties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix * [APIM]Add private endpoint connection APIs (Azure#15115) * Add private endpoint connection apis * add readme * quick fixes * fix to PE contract * Small fixes * small fixes * small fixes * Small fixes * small fixes * small fix * small fixes * small fixes * small fixes * Update readme.md * fix error * small fix * fix format * address comments * small fixes * Change to lower case * small fixes Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> * fix tenant sync contract * fix linter issues * examples for managed identity backup * prettier * Fix Apis-Get and updated comments for api-version 2021-04-01-preview (Azure#3) * add schema definition fix from 2021-01-01-preview * added fix * small fix (Azure#6) * 'examples' added to RepresentationContract (Azure#7) Co-authored-by: Alexander Zaslonov <zaslonov.alexander@gmail.com> Co-authored-by: DreamlessA <DreamlessA@users.noreply.github.com> Co-authored-by: Alan Feng <alanfeng@microsoft.com> Co-authored-by: Jatin Sanghvi <20547963+JatinSanghvi@users.noreply.github.com> Co-authored-by: Nicolás Barrera <nicolasbarrera@outlook.com> Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com> Co-authored-by: VitaliyKurokhtin <vitaliik@microsoft.com> Co-authored-by: RupengLiu <rliu1211@terpmail.umd.edu> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: RupengLiu <rupliu@microsoft.com> Co-authored-by: VitaliyKurokhtin <Vitaliy.Kurokhtin@gmail.com>

solankisamir and others added 30 commits June 15, 2021 10:40

Adds base for updating Microsoft.ApiManagement from version preview/2…

0c8648f

…021-01-01-preview to version 2021-04-01-preview

Updates readme

3db09f1

Updates API version in new specs and examples

785eaab

Added support for GraphQL API type (Azure#14851)

3d2e43a

* Added support for GraphQL API type * Added missing enum value for GraphQL APIs.

add schema definition fix from 2021-01-01-preview (Azure#14883)

e38dbf0

Co-authored-by: Alan Feng <alanfeng@microsoft.com>

Vanguard: Get Outbound Network Dependency (Azure#14900)

f322a47

* outbound dependency * fix resource

Update backup/restore API for managed identities (Azure#14973)

bbabd9c

* Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id

SystemData implemenation on API Management Control Plane (Azure#14899)

1018cb0

* system-data * fix spec * remove unreferenced file

APIM - Network Watcher Connectivity Check integration specs (Azure#15056

e8680fd

) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

Parameter examples added (Azure#14836)

5824638

platformversion (Azure#15114)

dc54a09

fix update service (Azure#15478)

b9e497e

HttpConnect example (Azure#15493)

ff76d20

* HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

Added properties of difference API spec format for "SchemaDocumentPro…

6e13784

…perties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix

Adds base for updating Microsoft.ApiManagement from version preview/2…

87ec243

…021-01-01-preview to version 2021-04-01-preview

Updates readme

68a9466

Updates API version in new specs and examples

e8923e5

Added support for GraphQL API type (Azure#14851)

02afe80

* Added support for GraphQL API type * Added missing enum value for GraphQL APIs.

add schema definition fix from 2021-01-01-preview (Azure#14883)

5ba3a75

Co-authored-by: Alan Feng <alanfeng@microsoft.com>

Vanguard: Get Outbound Network Dependency (Azure#14900)

5e00606

* outbound dependency * fix resource

Update backup/restore API for managed identities (Azure#14973)

45eb45b

* Update backup/restore API for system-assigned and user-assigned identities * Fix formatting issue * Rename user-assigned-msi-client-id with client-id

SystemData implemenation on API Management Control Plane (Azure#14899)

8c0bf6e

* system-data * fix spec * remove unreferenced file

APIM - Network Watcher Connectivity Check integration specs (Azure#15056

c09ae23

) * Connectivity Check API Specs * Fix * Fix errors * style fixs * Fix 202 code * HTTPConnect request parameters * Fix errors Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

Parameter examples added (Azure#14836)

50d808a

platformversion (Azure#15114)

98225ed

fix update service (Azure#15478)

c1297ec

HttpConnect example (Azure#15493)

ffaf5ae

* HttpConnect example * Prettifier fix Co-authored-by: Nicolás Barrera <t-nbarrera@microsoft.com>

Added properties of difference API spec format for "SchemaDocumentPro…

1112cc3

…perties" (Azure#15703) * add schema definition fix from 2021-01-01-preview * added properties for SchemaDocumentProperties * updated the fix * updated fix

chunyu3 added the BreakingChangeReviewRequired label Sep 14, 2021

'examples' added to RepresentationContract (#7)

2b794ad

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 21, 2021

chunyu3 merged commit 0208c5d into Azure:main Sep 23, 2021

leni-msft mentioned this pull request Sep 27, 2021

remove submodule #16171

Merged

25 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Microsoft.ApiManagement : Release api-version 2021-04-01-preview #15832

Microsoft.ApiManagement : Release api-version 2021-04-01-preview #15832

solankisamir commented Aug 27, 2021 •

edited

Loading

chunyu3 commented Sep 14, 2021

azure-pipelines bot commented Sep 14, 2021

openapi-workflow-bot bot commented Sep 14, 2021

solankisamir commented Sep 15, 2021

solankisamir commented Sep 20, 2021

VitaliyKurokhtin commented Sep 20, 2021

JeffreyRichter commented Sep 20, 2021

solankisamir commented Sep 20, 2021

JeffreyRichter commented Sep 20, 2021

VitaliyKurokhtin commented Sep 20, 2021

JeffreyRichter commented Sep 21, 2021

chunyu3 commented Sep 21, 2021

azure-pipelines bot commented Sep 21, 2021

chunyu3 commented Sep 23, 2021

Microsoft.ApiManagement : Release api-version 2021-04-01-preview #15832

Microsoft.ApiManagement : Release api-version 2021-04-01-preview #15832

Conversation

solankisamir commented Aug 27, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

chunyu3 commented Sep 14, 2021

azure-pipelines bot commented Sep 14, 2021

openapi-workflow-bot bot commented Sep 14, 2021

solankisamir commented Sep 15, 2021

solankisamir commented Sep 20, 2021

VitaliyKurokhtin commented Sep 20, 2021

JeffreyRichter commented Sep 20, 2021

solankisamir commented Sep 20, 2021

JeffreyRichter commented Sep 20, 2021

VitaliyKurokhtin commented Sep 20, 2021

JeffreyRichter commented Sep 21, 2021

chunyu3 commented Sep 21, 2021

azure-pipelines bot commented Sep 21, 2021

chunyu3 commented Sep 23, 2021

solankisamir commented Aug 27, 2021 •

edited

Loading